Обновление роли

Запрос позволяет обновить роль менеджера подразделения. Подробнее о ролях. Роли, которые могут быть выданы пользователю, можно посмотреть в его Личном кабинете.

Синтаксис запроса

POST https://b2b-api.go.yandex.ru/integration/2.0/managers/update?id={идентификатор менеджера}

Заголовки запроса

  • Authorization: Bearer <OAuth-токен>
    Процесс получения токена описан в разделе Начало работы.
  • X-YaTaxi-Selected-Corp-Client-Id — ID клиента из Личного кабинета. Обязателен, если по токену доступно несколько клиентов.

Параметры запроса

Запрос содержит обязательный параметр:

  • id — идентификатор менеджера подразделения, для которого обновляется роль.

Тело запроса

Данные о роли передаются в теле запроса в формате JSON:

Поле

Описание

Формат

Обязательность

fullname

Полное имя менеджера подразделения.

Строка

Да

email

Электронная почта менеджера подразделения.

Строка

Да

phone

Телефонный номер менеджера подразделения.

Строка

Да

yandex_login

Логин менеджера подразделения.

Строка

Да

role

Роль менеджера подразделения. Возможные значения: department_manager, department_secretary, client_manager.

Строка

Да

department_id

Идентификатор подразделения подразделения.

Строка

Нет

Описание полей ответа

В ответе с кодом 200 содержится поле:

Поле Описание Формат
id Идентификационный номер менеджера подразделения. Строка

Пример запроса

POST https://b2b-api.go.yandex.ru/integration/2.0/managers/update?id=07e4...b2f4
...
Authorization: Bearer <OAuth-token>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>

    {
        "yandex_login": "sample_yandex_login",
        "role": "department_manager",
        "department_id": "3648...396b",
        "phone": "+799900000000",
        "email": "email@example.com",
        "fullname": "Иванов Илья"
    }

Примеры ответа

Пример ответа на данный запрос с кодом 200 выглядит следующим образом:

{
    "id": "07e4...b2f4"
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

  • 200 — запрос выполнен успешно.
  • 400 — в запросе был передан неизвестный параметр или параметр с недопустимым значением.
  • 401 — был передан неверный OAuth-токен.
  • 403 — у клиента не хватает прав на выполнение данного запроса.
    • SELECT_CLIENT_HEADER_REQUIRED: в запросе не передан заголовок X-YaTaxi-Selected-Corp-Client-Id (возвращается в случае, если для токена доступно более одного клиента).
    • SELECTED_CLIENT_ACCESS_DENIED: в заголовке X-YaTaxi-Selected-Corp-Client-Id передан ID клиента, к которому нет доступа у этого логина.
  • 404 — менеджера с указанным id не существует.
  • 409 — конфликт одновременного доступа.
Предыдущая
Следующая